<h3>文件系统类</h3>
<p>
    系统内置了一个操作文件和目录的文件类，在需要时，随时可以实例化该类，该类名称为 <code>CLASS_FILE</code>，例如：<code>$obj_file = new CLASS_FILE();</code>。使用该类操作文件，推荐使用 <mark>绝对路径</mark>。
</p>
<p>
    该类文件位于 <code>./bg_core/class/file.class.php</code>，在开发者实例化时，系统会自动加载该文件，无需再 <code>include</code>，更为详细的使用可以参考该文件的源代码。
</p>

<div>&nbsp;</div>
<div class="text-right">
    <a href="#top">
        <span class="oi oi-chevron-top"></span>
        top
    </a>
</div>
<hr>
<div>&nbsp;</div>

<a name="attr"></a>
<h3>属性</h3>
<hr>
<div>&nbsp;</div>

<div class="table-responsive">
    <table class="table table-bordered">
        <thead>
            <tr>
                <th>属性</th>
                <th>类型</th>
                <th>说明</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>status</td>
                <td>bool</td>
                <td>操作状态 true 成功，false 失败。</td>
            </tr>
            <tr>
                <td>perms</td>
                <td>int</td>
                <td>新建目录的权限，默认为 0771。关于目录的权限请查看 <a href="http://www.php.net/manual/zh/function.chmod.php">PHP 官方网站</a></td>
            </tr>
        </tbody>
    </table>
</div>

<div>&nbsp;</div>
<div class="text-right">
    <a href="#top">
        <span class="oi oi-chevron-top"></span>
        top
    </a>
</div>
<hr>
<div>&nbsp;</div>

<a name="method"></a>
<h3>方法</h3>
<hr>
<div>&nbsp;</div>

<div class="table-responsive">
    <table class="table table-bordered">
        <thead>
            <tr>
                <th>方法</th>
                <th>说明</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td><a href="#dir_mk">dir_mk</a></td>
                <td>创建一个目录</td>
            </tr>
            <tr>
                <td><a href="#dir_list">dir_list</a></td>
                <td>列出一个目录</td>
            </tr>
            <tr>
                <td><a href="#dir_del">dir_del</a></td>
                <td>删除一个目录</td>
            </tr>
            <tr>
                <td><a href="#file_put">file_put</a></td>
                <td>写入一个文件</td>
            </tr>
            <tr>
                <td><a href="#file_read">file_read</a></td>
                <td>读取一个文件</td>
            </tr>
            <tr>
                <td><a href="#file_copy">file_copy</a></td>
                <td>复制一个文件</td>
            </tr>
            <tr>
                <td><a href="#file_del">file_del</a></td>
                <td>删除一个文件</td>
            </tr>
        </tbody>
    </table>
</div>

<div>&nbsp;</div>
<a name="dir_mk"></a>
<h4><code>dir_mk($path)</code></h4>

<p class="text-info">说明</p>
<p>创建一个目录。</p>

    <h4>参数</h4>
    <div class="table-responsive">
        <table class="table table-bordered">
            <thead>
                <tr>
                    <th class="text-nowrap">名称</th>
                    <th class="text-nowrap">类型</th>
                    <th class="text-nowrap">必需</th>
                    <th>描述</th>
                </tr>
            </thead>
            <tbody>
                <tr>
                    <td class="text-nowrap">path</td>
                    <td class="text-nowrap">string</td>
                    <td class="text-nowrap">true</td>
                    <td>要创建的路径。如果目录不存在，则会逐层创建。</td>
                </tr>
            </tbody>
        </table>
    </div>

    <h4>返回</h4>
    <p>true 成功，false 失败。</p>

<div>&nbsp;</div>
<div class="text-right">
    <a href="#top">
        <span class="oi oi-chevron-top"></span>
        top
    </a>
</div>
<hr>
<div>&nbsp;</div>

<a name="dir_list"></a>
<h4><code>dir_list($path[, $ext = ''])</code></h4>

<p class="text-info">说明</p>
<p>
    列出一个目录
</p>

    <h4>参数</h4>
    <div class="table-responsive">
        <table class="table table-bordered">
            <thead>
                <tr>
                    <th class="text-nowrap">名称</th>
                    <th class="text-nowrap">类型</th>
                    <th class="text-nowrap">必需</th>
                    <th>描述</th>
                </tr>
            </thead>
            <tbody>
                <tr>
                    <td class="text-nowrap">path</td>
                    <td class="text-nowrap">string</td>
                    <td class="text-nowrap">true</td>
                    <td>要读区的路径。如果目录不存在，则会逐层创建。</td>
                </tr>
                <tr>
                    <td class="text-nowrap">ext</td>
                    <td class="text-nowrap">string</td>
                    <td class="text-nowrap">false</td>
                    <td>指定扩展名，只列出指定扩展名的文件。</td>
                </tr>
            </tbody>
        </table>
    </div>

<div>&nbsp;</div>

    <h4>返回结果</h4>
    <p>
        目录列表。
    </p>

<div>&nbsp;</div>
<h5>返回结果示例</h5>
<p>
<pre class="border rounded"><code class="language-php">Array (
    [0] =&gt; Array (
        [name] =&gt; default //文件名
        [type] =&gt; dir //类型 dir 为目录, file 为文件
    )

    [1] =&gt; Array (
        [name] =&gt; test.txt
        [type] =&gt; file
    )

)</code></pre>
</p>

<div>&nbsp;</div>
<div class="text-right">
    <a href="#top">
        <span class="oi oi-chevron-top"></span>
        top
    </a>
</div>
<hr>
<div>&nbsp;</div>

<a name="dir_del"></a>
<h4><code>dir_del($path)</code></h4>

<p class="text-info">说明</p>
<p>
    删除一个目录
</p>

    <h4>参数</h4>
    <div class="table-responsive">
        <table class="table table-bordered">
            <thead>
                <tr>
                    <th class="text-nowrap">名称</th>
                    <th class="text-nowrap">类型</th>
                    <th class="text-nowrap">必需</th>
                    <th>描述</th>
                </tr>
            </thead>
            <tbody>
                <tr>
                    <td class="text-nowrap">path</td>
                    <td class="text-nowrap">string</td>
                    <td class="text-nowrap">true</td>
                    <td>要删除的路径。如果目录存在文件和子目录将会逐层全部删除。</td>
                </tr>
            </tbody>
        </table>
    </div>

<div>&nbsp;</div>

    <h4>返回结果</h4>
    <p>true 成功，false 失败。</p>

<div>&nbsp;</div>
<div class="text-right">
    <a href="#top">
        <span class="oi oi-chevron-top"></span>
        top
    </a>
</div>
<hr>
<div>&nbsp;</div>

<a name="file_put"></a>
<h4><code>file_put($path, $content)</code></h4>

<p class="text-info">说明</p>
<p>
    写入一个文件
</p>

    <h4>参数</h4>
    <div class="table-responsive">
        <table class="table table-bordered">
            <thead>
                <tr>
                    <th class="text-nowrap">名称</th>
                    <th class="text-nowrap">类型</th>
                    <th class="text-nowrap">必需</th>
                    <th>描述</th>
                </tr>
            </thead>
            <tbody>
                <tr>
                    <td class="text-nowrap">path</td>
                    <td class="text-nowrap">string</td>
                    <td class="text-nowrap">true</td>
                    <td>要写入的路径。如果目录不存在，则会逐层创建。</td>
                </tr>
                <tr>
                    <td class="text-nowrap">content</td>
                    <td class="text-nowrap">string</td>
                    <td class="text-nowrap">true</td>
                    <td>要写入的内容。</td>
                </tr>
            </tbody>
        </table>
    </div>

<div>&nbsp;</div>

    <h4>返回结果</h4>
    <p>true 成功，false 失败。</p>

<div>&nbsp;</div>
<div class="text-right">
    <a href="#top">
        <span class="oi oi-chevron-top"></span>
        top
    </a>
</div>
<hr>
<div>&nbsp;</div>

<a name="file_read"></a>
<h4><code>file_read($path)</code></h4>

<p class="text-info">说明</p>
<p>
    读取一个文件
</p>

    <h4>参数</h4>
    <div class="table-responsive">
        <table class="table table-bordered">
            <thead>
                <tr>
                    <th class="text-nowrap">名称</th>
                    <th class="text-nowrap">类型</th>
                    <th class="text-nowrap">必需</th>
                    <th>描述</th>
                </tr>
            </thead>
            <tbody>
                <tr>
                    <td class="text-nowrap">path</td>
                    <td class="text-nowrap">string</td>
                    <td class="text-nowrap">true</td>
                    <td>要读取的路径。如果目录不存在，则会逐层创建。</td>
                </tr>
            </tbody>
        </table>
    </div>

<div>&nbsp;</div>

    <h4>返回结果</h4>
    <p>
        文件内容
    </p>

<div>&nbsp;</div>
<div class="text-right">
    <a href="#top">
        <span class="oi oi-chevron-top"></span>
        top
    </a>
</div>
<hr>
<div>&nbsp;</div>

<a name="file_copy"></a>
<h4><code>file_copy($path_src, $path_dst)</code></h4>

<p class="text-info">说明</p>
<p>
    复制一个文件
</p>

    <h4>参数</h4>
    <div class="table-responsive">
        <table class="table table-bordered">
            <thead>
                <tr>
                    <th class="text-nowrap">名称</th>
                    <th class="text-nowrap">类型</th>
                    <th class="text-nowrap">必需</th>
                    <th>描述</th>
                </tr>
            </thead>
            <tbody>
                <tr>
                    <td class="text-nowrap">path_src</td>
                    <td class="text-nowrap">string</td>
                    <td class="text-nowrap">true</td>
                    <td>源文件路经。</td>
                </tr>
                <tr>
                    <td class="text-nowrap">path_dst</td>
                    <td class="text-nowrap">string</td>
                    <td class="text-nowrap">true</td>
                    <td>目的文件路经。如果目录不存在，则会逐层创建。</td>
                </tr>
            </tbody>
        </table>
    </div>

<div>&nbsp;</div>

    <h4>返回结果</h4>
    <p>true 成功，false 失败。</p>

